ナビゲーションをスキップ

WebLogic Server アプリケーションのデプロイメント

  前 次 前/次ボタンと目次ボタンとの区切り線 目次  

デプロイメント ツールのリファレンス

以下の節では、アプリケーションおよびスタンドアロン モジュールを WebLogic Server にデプロイするツールについて説明します。

 


weblogic.Deployer ユーティリティ

weblogic.Deployer ユーティリティは、非推奨になった以前の weblogic.deploy ユーティリティに代わるものです。weblogic.Deployer ユーティリティは、WebLogic Server デプロイメント管理 API  にコマンドライン インタフェースを提供する、Java ベースの開発ツールです。このユーティリティは、コマンドライン、シェル スクリプト、または Java 以外の自動化された環境からデプロイメントを開始する必要がある管理者および開発者向けに開発されました。

weblogic.Deployer ユーティリティの使い方

weblogic.Deployer を使用するには、次の手順に従います。

  1. WebLogic Server クラスをシステムの CLASSPATH に追加し、JDK が利用できるようにローカル環境を設定します。CLASSPATH の設定には、サーバの /bin ディレクトリにある setenv スクリプトを使用できます。
  2. 次のコマンド構文を使用します。
  3. % java weblogic.Deployer [options] [actions] [file(s)]

また、デプロイ (あるいは再デプロイまたはアンデプロイ) の対象となるアーカイブ内の特定の -files を一覧表示することもできます。ファイル リストには、ファイル名およびアプリケーションのルートを基準にしたディレクトリを含めることができます。ディレクトリを指定すると、サブツリー全体がデプロイまたは再デプロイされます。

weblogic.Deployer のアクションおよびオプション


 

次の表に weblogic.Deployer のオプションを示します。

注意 : activate アクションと deactivate アクションは非推奨になっています。activate の代わりには、deploy または start を使用します。deactivate の代わりには、undeploy または stop を使用します。

表 5-1 weblogic.Deployer のオプション

オプション

説明

-adminurl <protocol>://<server>:<port>

管理サーバの URL。デフォルトは http://localhost:7001

-username <user>

管理者のユーザ名。-username オプションを指定しても対応する -password オプションを指定しないと、weblogic.Deployer はパスワードを要求する。

-password <password>

管理者ユーザのパスワード。

スクリプトまたは ps などのプロセス ユーティリティでパスワードがプレーン テキストで表示されないようにするには、まず、weblogic.AdminSTOREUSERCONFIG コマンドを使用してユーザ名と暗号化されたパスワードをコンフィグレーション ファイルに格納する。デフォルト コンフィグレーション ファイルに格納された値を使用するには、weblogic.Deployer-username-password の両オプションを省略する。パスワードの格納と暗号化については、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」を参照。

デフォルト ファイル以外の特定のコンフィグレーション ファイルとキー ファイルを使用するには、weblogic.Deployer-userconfigfile および -userkeyfile オプションを使用する。

-name <deployment name>

アプリケーションまたはスタンドアロン モジュールのデプロイメント名を指定する。この名前は、既存またはコンフィグレーション済みのアプリケーション名、あるいは新しいコンフィグレーション作成時に使用する名前でも可。

-targets <target list>

対象サーバ名またはクラスタ名 (あるいはその両方) のカンマ区切りのリスト (<server1>,<cluster1>,...)。各対象は J2EE モジュール名を使用して修飾できる (<module1>@<server1>)。これによりアーカイブの各種モジュールをさまざまなサーバにデプロイできる。

現在デプロイされているアプリケーションについては、-targets はデフォルトで現在の対象すべてになる。初めてデプロイするアプリケーションについては、-targets はデフォルトで管理サーバになる。

-delete_files <file list>

このオプションを -redeploy アクションの後に使用すると、サーバのステージング ディレクトリから静的ファイルが削除される。delete_files は、展開されたデプロイメント、および stage モードを使用してデプロイされたアプリケーションでのみ有効。このオプションを使用するときには、次の例のようにして対象サーバを指定する必要がある。

java weblogic.Deployer -adminurl http://myserver:7001 -username weblogic
-password weblogic -name myapp
-targets myapp@myserver -redeploy
-delete_files myapp/tempindex.html

delete_files は、デプロイメント時にステージング領域にコピーされたファイルのみを削除する。nostage または external_stage モードを使用してデプロイされたアプリケーションで delete_files オプションを使用した場合、ファイルは削除されない。

delete_files は、redeploy アクションと一緒でないと使用できない。

-userconfigfile <path to file>

管理ユーザ名および管理パスワードに使用するユーザ コンフィグレーション ファイルの位置を指定する。このオプションは、自動化されたスクリプトで、あるいは画面上または ps などのプロセスレベルのユーティリティでパスワードを表示したくない状況で、-user および -password オプションの代わりに使用する。-userconfigfile オプションを指定する前に、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」の説明に従って weblogic.Admin STOREUSERCONFIG コマンドを使用してファイルを生成する必要がある。

-userkeyfile <path to file>

ユーザ コンフィグレーション ファイル (-userconfigfile オプション) に格納されたユーザ名とパスワードの情報を暗号化および復号化するために使用するユーザ キー ファイルの位置を指定する。-userkeyfile オプションを指定する前に、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」の説明に従って weblogic.Admin STOREUSERCONFIG コマンドを使用してファイルを生成する必要がある。

-verbose

追加の進行状況メッセージを表示する (デプロイメントの準備フェーズとアクティブ化フェーズについての詳細など)。

-output <raw>

raw または formatted を指定して、weblogic.Deployer の出力メッセージの表示方法を制御する。両方の出力タイプに含まれる情報は同じだが、raw 出力では埋め込みタブが使われない。デフォルトでは、weblogic.Deployer の表示は raw 出力になる。

-debug

標準出力にデバッグ メッセージを表示する。

-help

よく使用する weblogic.Deployer のアクションとオプションについて、コマンドライン ヘルプ テキストを出力する。

-advanced

weblogic.Deployer のすべてのアクションとオプションについて、詳細なコマンドライン ヘルプ テキストを出力する。

-examples

一般的なタスクのコマンドラインの例を表示する。

-upload

指定されたソース ファイルを管理サーバに転送する。このオプションは、管理サーバとは別のマシンで作業していて、ほかの方法でデプロイメント ファイルをコピーできない場合に使用する。アプリケーション ファイルは、デプロイメント前に WebLogic Server 管理サーバのアップロード ディレクトリにアップロードされる。

-remote

weblogic.Deployer が管理サーバと同じマシンで動作していないこと、およびコマンドに指定するソース パスが管理サーバ マシン自体に対して有効であることを示す。-remote オプションを使用しない場合、weblogic.Deployer はすべてのソース パスをローカル マシン上の有効なパスと想定する。

-nostage

デプロイメント ファイルを対象サーバにコピーしない。その代わりに、-source オプションを使用して指定した固定の場所からデプロイする。

nostage は、(単一サーバ ドメインなどの) 管理サーバにデプロイする際のデフォルト。

-stage

デプロイメント前にデプロイメント ファイルを対象サーバのステージング ディレクトリにコピーする。

stage は、管理対象サーバを対象としてデプロイする場合のデフォルトとして使用される。

-external_stage

デプロイメント ファイルを対象サーバにコピーしない。その代わりに、デプロイメント ファイルがデプロイの前に対象サーバのステージング ディレクトリの正しいサブディレクトリにコピーされていることを確認しておく必要がある。ファイルを手動でコピーしたり、サードパーティのツールやスクリプトを使用したりできる。

-nowait

weblogic.Deployer はタスク ID を出力し、アクションの完了を待たずに終了する。このオプションは複数のタスクを開始し、-list アクションを使用して後でモニタするために用いる。

-timeout <seconds>

デプロイメント タスクの完了までの最長待ち時間 (秒単位) を指定する。時間の経過後、weblogic.Deployer はデプロイメントの現在のステータスを出力して終了する。

-source <archive file or exploded archive directory>

デプロイするアーカイブ ファイルまたは展開されたアーカイブ ディレクトリの場所を指定する。

-altappdd

デプロイメントに使用する代替 J2EE デプロイメント記述子 (application.xml) の名前を指定する。

-altwlsappdd

デプロイメントに使用する代替 WebLogic Server デプロイメント記述子 (weblogic-application.xml) の名前を指定する。

-id <task identifier>

実行中のデプロイメント タスクのタスク識別子を指定する。識別子は、-deploy-redeploy、または -undeploy アクションで指定でき、後から -cancel または -list アクションの引数として使用できる。識別子は、実行中の他のデプロイメント タスクすべてを通してユニークでなければならない。指定しない場合、システムによってユニークな識別子が自動的に生成される。

-version

バージョン情報を出力する。

表 5-2 weblogic.Deployer のアクション

アクション

説明

-deploy

アプリケーションをデプロイまたは再デプロイする。

-undeploy

デプロイメント ユニットを停止し、すべての対象サーバからステージングされているファイルとデプロイメント情報を削除する (-remove をエイリアスとして使用することもできる)。

注意 : アプリケーションは、アンデプロイメント中はクライアントから使用できない。WebLogic Server では、アンデプロイメント時にクライアントからアクセスがあった場合、アプリケーション操作およびデプロイメント操作は保証されない。

-redeploy

実行中のアプリケーションまたは実行中のアプリケーションの一部を置き換える。

注意 : アプリケーションは、再デプロイメント中はクライアントから使用できない。WebLogic Server では、再デプロイメント時にクライアントからアクセスがあった場合、アプリケーション操作およびデプロイメント操作は保証されない。このため、プロダクション環境で使用する場合には再デプロイはお勧めしない。

-stop

アプリケーションを非アクティブにし、対象サーバ上のクライアントで使用できないようにする。デプロイメント情報とステージングされたファイルは対象サーバ上で使用可能な状態のままとなり、以降の -start-deploy-redeploy、または -undeploy の各アクションで使用できる。

-start

非アクティブなアプリケーションを対象サーバ上のクライアントで使用できるようにする。-start ではデプロイメント ファイルは対象サーバに再配布されない。デプロイメント ファイルは、あらかじめ -deploy または -distribute アクションで使用できるようにしておく必要がある。

-distribute

デプロイメントのアクティブ化ステージのみを実行する。すなわち、デプロイメント ファイルを対象サーバのステージング ディレクトリにコピーし (必要な場合)、デプロイメント名を登録する。アプリケーションはデプロイメントの準備が整うが、対象サーバ上のクライアントからは使用できない。

後から -start アクションを使用してアプリケーションをクライアントから使用できるようにすることができる。

-cancel

-id で識別されるタスクがまだ完了していない場合、そのタスクの取り消しを試みる。

-list

-id で識別されるタスクのステータスを示す。

-listtask

ドメインで実行中のデプロイメント タスクをリストする。

-listapps

ドメインにデプロイされているアプリケーションとスタンドアロン モジュールのデプロイメント名をすべてリストする。

 


wldeploy Ant タスク

wldeploy Ant タスクでは、Ant XML ファイルに指定する属性を使用して weblogic.Deployer の機能を実行できます。wldeploy を他の WebLogic Server Ant タスクとともに使用して、以下を実行する単一の Ant ビルド スクリプトを作成できます。

wlserverwlconfig の詳細については、『WebLogic Server コマンド リファレンス』の「Ant タスクを使用した WebLogic Server ドメインのコンフィグレーション」を参照してください。wlcompile の詳細については、『WebLogic Server アプリケーションの開発』の「プログラミング トピック」を参照してください。

wldeploy を使用する基本手順

wldeploy Ant タスクを使用するには、次の手順に従います。

  1. 環境を設定します。
  2. Windows NT では、WL_HOME\server\bin ディレクトリにある setWLSEnv.cmd コマンドを実行します。WL_HOME は、インストールされている WebLogic Server の最上位ディレクトリです。

    UNIX では、WL_HOME/server/bin ディレクトリにある setWLSEnv.sh コマンドを実行します。WL_HOME は、インストールされている WebLogic Server の最上位ディレクトリです。

  3. ステージング ディレクトリで、Ant ビルド ファイル (デフォルトは build.xml) を作成します。WebLogic Server と一緒にインストールされたものとは異なる Ant を使用する場合は、wldeploy Ant タスクを定義することから始めます。
  4. <taskdef name="wldeploy" classname="weblogic.ant.taskdefs.management.WLDeploy"/>
  5. 必要に応じて、新しい WebLogic Server ドメインを作成するためのタスク定義と wlserver および wlconfig タスクの呼び出しをビルド スクリプトに追加します。wlserverwlconfig の詳細については、『WebLogic Server コマンド リファレンス』の「Ant タスクを使用した WebLogic Server ドメインのコンフィグレーション」を参照してください。
  6. wldeploy の呼び出しを追加して、アプリケーションを 1 つまたは複数の WebLogic Server インスタンスまたはクラスタにデプロイします。「wldeploy 用 build.xml ファイルのサンプル」と「wldeploy Ant タスクのリファレンス」を参照してください。
  7. ステージング ディレクトリで ant と入力し、必要であればこのコマンドにターゲットの引数を渡して、build.xml ファイルで指定された Ant タスク (1 つまたは複数) を実行します。
  8. prompt> ant

wldeploy 用 build.xml ファイルのサンプル

次のサンプルは、アプリケーションを単一の WebLogic Server インスタンスにデプロイする wldeploy のデプロイ先を示しています。

<target name="deploy">
   <wldeploy action="deploy"
      source="${build}/ejb11_basic_statelessSession.ear" name="ejbapp"
      user="a" password="a" verbose="true" adminurl="t3://localhost:7001"
      debug="true" targets="myserver"/>
</target>

次のサンプルは、展開された Web アプリケーション内に単一のファイルを再デプロイする、より高度な wldeploy のデプロイ先を示しています。

<target name="redeploy">
   <wldeploy action="redeploy"
      source="c:\myapps\myWebApp\" name="myWebApp"
      user="weblogic" password="weblogic" verbose="true"
      adminurl="t3://localhost:7001"
      debug="true" targets="examplesServer">
     <files file="index.jsp"/>
   </wldeploy>
</target>

wldeploy Ant タスクのリファレンス

次の表では、wldeploy Ant タスクの属性について説明します。さまざまな用語の定義については、「weblogic.Deployer のアクションおよびオプション」を参照してください。

表 5-3 wldeploy Ant タスクの属性

属性

説明

データ型

必須/任意

action

実行するデプロイメント アクション。有効な値は、deploycancelundeployredeploydistributestart、および stop

String

任意

adminurl

管理サーバの URL。

String

任意

altappdd

デプロイメントに使用する代替 J2EE デプロイメント記述子 (application.xml) の名前を指定する。

String

任意

altwlsappdd

デプロイメントに使用する代替 WebLogic Server デプロイメント記述子 (weblogic-application.xml) の名前を指定する。

String

任意

debug

wldeploy デバッグ メッセージを有効にする。

boolean

任意

external_stage

デプロイメントで external_stage デプロイメント モードを使用するかどうかを指定する。

boolean

任意

files

デプロイメント アクションを実行するファイルまたはファイルのリストを指定する (再デプロイする JSP のリストなど)。「wldeploy 用 build.xml ファイルのサンプル」を参照。

FileSet

任意

id

デプロイメントのステータスの取得やデプロイメントの取り消しに使用される ID。

String

任意

name

デプロイ済みのアプリケーションのデプロイメント名。

String

任意

nostage

デプロイメントで nostage デプロイメント モードを使用するかどうかを指定する。

boolean

任意

nowait

wldeploy が (バックグラウンド タスクとしてデプロイすることによって) デプロイメント呼び出しの直後に返るかどうかを指定する。

boolean

任意

password

管理パスワード。

ビルド ファイルまたは ps などのプロセス ユーティリティでパスワードがプレーン テキストで表示されないようにするには、まず、weblogic.Admin STOREUSERCONFIG コマンドを使用して有効なユーザ名と暗号化されたパスワードをコンフィグレーション ファイルに格納する。次に、Ant ビルド ファイルで usernamepassword の両属性を省略する。これらの属性を省略すると、wldeploy はデフォルト コンフィグレーション ファイルの値を使用してログインを試みる。

デフォルト以外のコンフィグレーション ファイルとキー ファイルからユーザ名およびパスワードを取得する場合は、wldeployuserconfigfile 属性と userkeyfile 属性を使用する。

パスワードの格納と暗号化については、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」を参照。

String

任意

remote

サーバが別のマシンに配置されているかどうかを指定する。これはファイル名の転送方法に影響する。

boolean

任意

source

デプロイするソース ファイル。

File

任意

stage

デプロイメントで stage デプロイメント モードを使用するかどうかを指定する。

boolean

任意

targets

デプロイ先となる対象サーバのリスト。

String

任意

timeout

デプロイメントが正常に終了するまでの最長待ち時間。

int

任意

upload

デプロイメントの前にソース ファイルが管理サーバのアップロード ディレクトリにコピーされるかどうかを指定する。

boolean

任意

user

管理ユーザ名。

String

任意

userconfigfile

管理ユーザ名および管理パスワードを取得するために使用するユーザ コンフィグレーション ファイルの位置を指定する。このオプションは、プレーン テキストのパスワードをインラインに表示したくない場合はビルド ファイルで、または ps などのプロセスレベルのユーティリティで user および password 属性の代わりに使用する。-userconfigfile 属性を指定する前に、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」の説明に従って weblogic.Admin STOREUSERCONFIG コマンドを使用してファイルを生成する必要がある。

String

任意

userkeyfile

ユーザ コンフィグレーション ファイル (userconfigfile 属性) に格納されたユーザ名とパスワードの情報を暗号化および復号化するために使用するユーザ キー ファイルの場所を指定する。-userkeyfile 属性を指定する前に、「weblogic.Admin コマンドライン リファレンス」の「STOREUSERCONFIG」の説明に従って weblogic.Admin STOREUSERCONFIG コマンドを使用してファイルを生成する必要がある。

String

任意

verbose

wldeploy で詳細出力メッセージを表示するかどうかを指定する。

boolean

任意

failonerror

WebLogic Server Ant タスクで使用されるグローバル属性。ビルド中にエラーが発生した場合、タスクを失敗させるかどうかを指定する。この属性は、デフォルトで true に設定される。

Boolean

任意

.

 


WebLogic Builder

WebLogic Builder は、J2EE アプリケーションのデプロイメント記述子を生成および編集するための WebLogic Server ツールです。このツールでは、単一のサーバにアプリケーションをデプロイすることもできます。

WebLogic Builder オンライン ヘルプ』を参照してください。

 


デプロイメント管理 API

デプロイメント タスクは、DeployerRuntimeMBean という、管理サーバに常駐するシングルトン (インスタンスが 1 つしかないオブジェクト) によって開始されます。この DeployerRuntimeMBean によって、アプリケーションをアクティブ化、非アクティブ化、および削除するためのメソッドが提供されます。これらのメソッドは、リクエストをカプセル化し、その進行状況を追跡する手段を提供する DeploymentTaskRuntimeMBean を返します。DeploymentTaskRuntimeMBean は、TargetStatus オブジェクトによってデプロイ先ごとにリクエストに関する処理ステータスを示します。

WebLogic Server デプロイメント管理 API は、以下の WebLogic Server MBean によって定義されます。

デプロイメント管理 API は非同期です。クライアントは、ステータスをポーリングするか、ApplicationMBean 通知を使用してタスクがいつ完了したかを判別します。

WebLogic Server のデプロイメント管理 API の詳細については、「weblogic.management.deploy」Javadoc を参照してください。

 

ページの先頭 前 次